/*
 * Copyright (C) 2010 Graham Allan
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package edu.strath.cis.grallan.findbugs.adaptiveranking.gui;

import javax.swing.JEditorPane;
import javax.swing.text.JTextComponent;

import edu.strath.cis.grallan.findbugs.adaptiveranking.gui.IRankingModeHelpInfo.IQuestionAndAnswer;

/**
 * @author Graham Allan (grallan@cis.strath.ac.uk)
 */
public class HelpContainerProvider {

	public JTextComponent getContainerForHelp(IRankingModeHelpInfo helpInfo) {

		JEditorPane helpPane = new JEditorPane();
		helpPane.setEditable(false);
		helpPane.setContentType("text/html; charset=UTF-8");

		StringBuilder helpText = new StringBuilder();
		helpText.append("<h2>" + helpInfo.modeName() + "</h2>\n");
		helpText.append("<b>Introduction</b>");
		helpText.append("<p>" + helpInfo.briefInformation() + "</p>\n");

		for (IQuestionAndAnswer qna : helpInfo.faqs()) {
			helpText.append("<p>");
			helpText.append("<h3>" + qna.question() + "</h3>\n");
			helpText.append(qna.answer());
			helpText.append("</p>");
		}

		helpPane.setText(helpText.toString());
		helpPane.setCaretPosition(0);

		return helpPane;
	}
}
